Public Property Set Key AsString
Sets the description for the e-mail address by which it can be accessed
from a list and checks on not allowed characters.
Example "Notes" for the Notes e-mail address of a person.
- Errors:
Public Property Get Key AsString
Public Property Set EMailAddress AsString
Sets the e-mail address maintained by this object and checks on not allowed characters.
- Errors:
Public Property Get EMailAddress AsString
Public Property Set Delimiter AsString
When the object is imploded to a serial data string this character will be used
as seperator. If the programmer doesn't set a delimiter a default value will be
delivered by the class.
Public Property Get Delimiter AsString
Public Property Set NotAllowedChars AsVariant
These characters are not allowed to be use in the key and emailaddress properties
Public Property Get NotAllowedChars AsVariant
Public Property Set DisplayFormat AsString
The display format is a rule for formatting the object data when
the property 'Formatted' is used. The values of the constants
EMI_DEFAULT_KEY_NAME and EMI_DEFAULT_EMAIL_NAME has to be used to form the format
Public Property Get DisplayFormat AsString
Public Property Get Formatted AsString
Formats the object's data in a user defined way
New
Public Sub New(newKey As String,newEMailAddress As String)
Sets the properties Key and EMailAddress with the parameter values.
Default values for the properties Delimiter, NotAllowedChars and DisplayFormat are set.
- Parameters:
| newKey | String | the key of the new object
|
| newEMailAddress | String | e-mail address maintained by the new object
|
Delete
Public Sub Delete
Implode
Public Function Implode As String
This method writes the data of the object to a serialized data string.
The string should be of the form: ~~~~.
- Returns:
| String | serial data string representing the object
|
explode
Public Sub explode(SerializedObj As String)
Transforms a string build by the implode method in its components.
The string should be in the form ~~ ~ or
~~~~.
Old values for Key and EMailAddress are resetted.
- Parameters:
| serializedObj | String | String of the format as delivered by the implode method
|
- Errors:
| ErrDataDoesntCorrespondToObject | |
Validate
Public Sub Validate
The validate method checks that the properties "Key" and "EMailAddress"
aren't empty.
- Errors:
| ErrAddressTypeEmpty | |
| ErrMailAddressEmpty | |
Clear
Public Sub Clear
Clears the values of the e-mail item object.
After the usage of clear the method IsEmptyInstance will deliver true as return value.
IsEmptyInstance
Public Function IsEmptyInstance As Integer
Checks if attributes key and emailaddress are empty strings.
- Returns:
| Boolean | true, if attributes key and emailaddress are empty
|
CompareTo
Public Function CompareTo(CompItem As LSAEMailItem) As Integer
Compares the properties Key and EMailAddress of the EMailItem object.
- Parameters:
| compItem | LSAEMailItem | the object to compare against
|
- Returns:
| boolean | true, if objects have same attributes
|
hasAttributeChanged
Public Function hasAttributeChanged(attrName As String) As Integer
Checks if the attribute with the name attrName has heen changed
- Parameters:
| attrName | String | the name of the attribute to check
|
- Returns:
| boolean | true, if the attribute has changed
|
hasChanged
Public Function hasChanged As Integer
Checks one of the objects attributes has been changed
| Top | LotusScript Doc |
| © Lotus Professional Services |
| generated on : 05-Apr-01 8:40:00 AM |